Skip to main content

Get Policy

Route

/v2/policies/{id}

Description

Retrieve a specific policy by its unique identifier. Returns detailed information about the policy configuration and enforcement rules.

Method

GET

Inputs

ParameterTypeRequiredDescription
idstringYesThe id of the policy to retrieve

Output

FieldTypeDescription
typestringAlways "policies"
sizeintegerNumber of policies returned (always 1)
resourcesarray[Policy]Array containing the requested policy
errorsarray[Error]Any errors encountered

Policy Object Structure

FieldTypeDescription
idstringUnique policy identifier
versionstringVersion identifier for concurrency control
typestringPolicy type (data_protection, content_inspection)
namestringHuman-readable name
descriptionstringDetailed description
severitystringSeverity level (informational, low, medium, high, critical)
disabledbooleanWhether the policy is disabled
selection_typestringHow datasets are selected (dataset, sensitivity)
dataset_idsarray[string]Specific dataset IDs (when selection_type is dataset)
dataset_sensitivitiesarray[integer]Sensitivity levels (when selection_type is sensitivity)
ruleobjectRule configuration for enforcement actions
created_atstringCreation timestamp (ISO 8601)
last_modifiedstringLast modification timestamp (ISO 8601)

Rate Limit

  • 60 requests per minute per API key
  • 5 concurrent requests per endpoint

Example Response

{
"type": "policies",
"size": 1,
"resources": [
{
"id": "policy-123",
"version": "v1.2.3",
"type": "data_protection",
"name": "Customer PII Protection",
"description": "Protect customer personal information",
"severity": "high",
"disabled": false,
"selection_type": "dataset",
"dataset_ids": ["dataset-456"],
"rule": {
"status": "risky",
"create_incident": true,
"record_screenshots": true,
"inspect_content": true,
"realtime_response_config": {
"incident_action": "warn",
"require_justification": true
}
},
"created_at": "2024-01-15T10:30:00Z",
"last_modified": "2024-01-20T14:15:00Z"
}
],
"errors": []
}